HealthCategoryValue Types# PRO

This document provides a comprehensive reference for all supported HealthCategoryValue enums used with HealthCategorySample.create() and related APIs. Each enum represents a specific categorical value associated with a HealthCategoryType.

#1. HealthCategoryValuePresence

Applicable Types:

• mindfulSession
• intermenstrualBleeding
• sexualActivity
• pregnancy
• lactation

Description: Indicates the presence or absence of an event.

#2. HealthCategoryValueSeverity

Applicable Types:

• menstrualFlow
• acneSeverity
• hairLossSeverity
• abdominalCramps
• headache
• nausea

Description: Represents the severity level of a symptom.

#3. HealthCategoryValueSleepAnalysis

Applicable Types:

• sleepAnalysis

Description: Categorizes sleep states during a given time range.

#4. HealthCategoryValueOvulationTestResult

Applicable Types:

• ovulationTestResult

#5. HealthCategoryValuePregnancyTestResult

Applicable Types:

• pregnancyTestResult

#6. HealthCategoryValueProgesteroneTestResult

Applicable Types:

• progesteroneTestResult

#7. HealthCategoryValueCervicalMucusQuality

Applicable Types:

• cervicalMucusQuality

#8. HealthCategoryValueContraceptive

Applicable Types:

• contraceptive

#9. HealthCategoryValueVaginalBleeding (iOS 18+)

Applicable Types:

• vaginalBleeding

#10. HealthCategoryValueAppetiteChanges

Applicable Types:

• appetiteChanges

#11. HealthCategoryValueAppleStandHour

Applicable Types:

• appleStandHour

#12. HealthCategoryValueAppleWalkingSteadinessEvent

Applicable Types:

• appleWalkingSteadinessEvent

#13. HealthCategoryValueEnvironmentalAudioExposureEvent

Applicable Types:

• environmentalAudioExposureEvent

#14. HealthCategoryValueHeadphoneAudioExposureEvent

Applicable Types:

• headphoneAudioExposureEvent

#15. HealthCategoryValueLowCardioFitnessEvent

Applicable Types:

• lowCardioFitnessEvent

#Usage Example

const sample = HealthCategorySample.create({
  type: "menstrualFlow",
  startDate: new Date("2025-07-03T10:00:00"),
  endDate: new Date("2025-07-03T12:00:00"),
  value: HealthCategoryValueSeverity.moderate
})

await Health.saveCategorySample(sample)

#Notes

• Each enum value must match the type specified in the sample; using an incorrect enum will result in an error.
• Ensure HealthKit permissions are granted before saving or reading samples.
• HealthCategorySample values are stored using Apple's HKCategoryTypeIdentifier mapping under the hood.